Range

Function

This API is used to get parameter range for Channel > Video Crop page.

Note:

The Range provides reference information for client UI input limits and API request limits. When sending Get and Set requests, the parameters must be strictly limited according to the Range, otherwise the request may be rejected by the device.

Request Message

None.

Sample:

POST /API/ChannelConfig/VideoCrop/Range HTTP/1.1
To be added

Response Message

Parameter Description

Table 1

ParameterRangeTypeDescription
channel“CH1”…”CH1x”
“IP_CH1”…” IP_CH1x”
“WIFI_CH1”…” WIFI_CH1x”
The number of channels depends on the capabilities of the device.
string arrayEach array bit represents a channel with a string.

Table 2

ParameterRangeTypeDescription
channel_infoJSON ObjectChannel Information JSON show as follow Table 3
channel_maxintMaximum number of channels.

Table 3

ParameterRangeTypeDescription
CH1Json ObjectJSON show as follow Table 4
Json Object
IP_CH1Json Object
Json Object
WIFI_CH1Json Object
Json Object

Table 4

ParameterRangeTypeDescription
status"Offline",
"Online"
stringChannel online status, only for digital channels. Note: This field does not exist when the channel is online.
enableboolEnable switch.
fps1-10intCrop Fps
zone_infoJSON arrayJSON show as follow Table 5
Note: Currently only two regions are supported.

Table 5

ParameterRangeTypeDescription
zone_no1-2intZone number
rectJSON objectJSON show as follow Table 6

Table 6

ParameterRangeTypeDescription
left0-704intLeft
top0-576intTop
width0-704intWidth
height0-576intHeight

Tips:

The response message of the Range request may not contain all the fields in the above table, and the fields not included indicate that the device does not support this parameter configuration.

Sample:

HTTP/1.1 200 OK
Content-Type: application/json
To be added.

Error Code

See Response Messages Body and Common error_code for more information.